home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 1 / Cream of the Crop 1.iso / PROGRAM / A86ENV.ARJ / ASENV.DOC next >
Text File  |  1991-10-08  |  13KB  |  366 lines

  1.  
  2.                            ASENV v0.1 - 1991
  3.                     A86 Assembler Working Environment
  4.  
  5.     A86 is Copyright 1986--1990 by Eric Isaacson
  6.     ASENV is written by S.L.I. and released to the PUBLIC DOMAIN - 1991
  7.  
  8.     NOTE : ASENV is written and compiled in QuickBasic 4.0
  9.  
  10.         -------------------------------------------------------
  11.  
  12.     the STORY:
  13.  
  14.     I've been a professional programmer for over 12 years, now, mostly on
  15.     mainframe and super-mini computers, and dealing almost exclusively with
  16.     higher level languages (COBOL, FORTRAN, BASIC, etc.). A couple of years
  17.     ago, I decided to add the DOS-compatible PC-level machines to my
  18.     knowledge base (I'd been 'playing' with a Commodore-64 since 1983).
  19.     While looking for an assembler/compiler to handle the xx88 and xxx86
  20.     assembler language, I found the A86 assembler package by Eric Isaacson.
  21.     This has got to be one of the best representations of a concept in the
  22.     DOS world which I've seen growing by leaps and bounds: that of extremely
  23.     acceptable 'commercial' quality software being written and offered on
  24.     the shareware level. Not only is A86 priced better than those packages
  25.     offered commercially, but in almost every functional respect A86 either
  26.     matched or exceeded the capabilities of those 'other' packages.
  27.  
  28.     There was one thing missing, however. All of the A86 programs were run
  29.     from the command-line (or a user-written batchfile). Most of the other
  30.     packages offered the user a 'working environment' or 'shell' to ease
  31.     the tedium of the reiterative loop of writing source code, compiling,
  32.     linking, and running programs. This shell, while not imperative, does
  33.     add to the productivity of a programmer, and also makes a package more
  34.     attractive.
  35.  
  36.     Having just recently upgraded to DOS 5.0, I was looking for a task to
  37.     familiarize myself with the QuickBasic language, and also wished to try 
  38.     to develop some sort of 'shell' for my own use of A86 (I'm just starting
  39.     to learn PC assembler, so anything to make my life easier is a BIG
  40.     plus).
  41.  
  42.     Well, ASENV (ASembler ENVironment) is the result. This is only the first
  43.     version. There WILL be more coming (as I start needing other tools and
  44.     functions), but I think that this is ready for a first release.
  45.  
  46.  
  47.  
  48.  
  49.  
  50.     Take it, try it, and if you like it, use it. Have fun!
  51.  
  52.     Please leave any comments to:
  53.  
  54.     Karl B. Carapellotti
  55.     CompuServe ID 70046,1401
  56.  
  57.  
  58.  
  59.  
  60.                                       - 1 -
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.     NOTES ON ASENV:
  69.  
  70.     When using ASENV, the following considerations are in effect:
  71.  
  72.     1)  The A86 program (and its supporting files) must be available in
  73.         your working directory, or in your PATH statement.
  74.  
  75.     2)  As of this release (v0.1), ASENV tries to make intelligent decisions
  76.         about the drives, paths, filenames, and file extensions you enter,
  77.         but you can defeat it by doing something silly. For instance, at
  78.         the F1/Working file entry, you may enter a base filename (without
  79.         extension), or a filename.extension, or a full working filename
  80.         (drive:\path\path\filename.extension). ASENV will try to parse over
  81.         the entry, and change your environment to the requested parameters,
  82.         but it does NOT check the validity of these parameters (yet!).
  83.  
  84.         If you enter something like :
  85.        
  86.         'W:\firstpath\secondsub\thisismyfile.toolongextension',
  87.  
  88.         and don't have a W: drive, or use invalid path/file/extension names,
  89.         ASENV will still try to make the changes (it won't succeed, but it
  90.         will TRY).
  91.  
  92.         A certain modicum of intelligence on the part of the user is
  93.         assumed. Let's be honest, if you're not knowledgeable enough to
  94.         use DOS, then you have NO business in an ASSEMBLER environment!
  95.  
  96.     3)  A86 includes many command-line switches which affect the assembly,
  97.         the output, and other functions of the assembly process. As of
  98.         version 0.1, I have chosen to only support two of them : the
  99.         's' switch (to enable/disable creation of .SYM(bol) files), and the
  100.         'o' switch (to enable/disable creation of linkable .OBJ(ect) files).
  101.         More (maybe even all) of them will be available in future releases.
  102.  
  103.     4)  ASENV allows you to use your favourite text editor to edit source
  104.         files. The default at entry is the DOS 5.0 EDIT program. Whether you
  105.         change the editor program or not, the editor being used MUST be
  106.         available on your current directory or path. Full DOS filenames are
  107.         usable for your editor (e.g. 'E:\util\myeditor.com'), but, as in note
  108.         #2 above, YOU are responsible for the correctness of the entry.
  109.         Command-line switches for the editor are NOT supported (yet!).
  110.  
  111.     5)  ASENV always starts up in 'default' mode. There is not (yet!) any
  112.         option to SAVE your current files and other working parameters.
  113.         Coming soon!
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.                                       - 2 -
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.     USING ASENV :
  130.  
  131.     When you first enter ASENV, the screen will display:
  132.  
  133.  
  134.     -------------------------------------------------------------------
  135.  
  136.                  * * *  A86 Assembler Environment * * *vx.x
  137.  
  138.           F1 / Workfile   : default
  139.           F2 / Pgm Editor : edit
  140.           F3 / Edit                     F6 / Object create  : off
  141.           F4 / Assemble                 F7 / Symbol create  : on
  142.           F5 / Run                      F8 / File Extension : src
  143.                                         F9 / ? Dir of all src files
  144.           esc  = exit                  F10 / DOS shell
  145.           Current directory : d:\xxxxx
  146.  
  147.  
  148.                         Enter Selection:
  149.  
  150.     -------------------------------------------------------------------
  151.  
  152.  
  153.     To select an option, enter the associated function key (1-10), or enter
  154.     the first letter of the option (except for 'esc' which means the 'escape'
  155.     key). No carriage-return or enter key is needed.
  156.  
  157.     The options available are:
  158.  
  159.     F1 or W -   change/enter workfile name. This is the name of the current 
  160.                 source code file. You may enter just a base file name, and
  161.                 ASENV will use the displayed drive, directory, and file
  162.                 extension, or you may enter anything up to a full (valid) DOS
  163.                 filename, including the drive letter, the path, the filename
  164.                 and the extension. ASENV will parse over the entered string,
  165.                 pull out anything it recognizes as a drive, path, or file
  166.                 extension, and change your current working environment to
  167.                 it (them).
  168.  
  169.     F2 or P -   the name of the (text) editor you wish to use to create and
  170.                 modify source code. You should enter this exactly the way
  171.                 you would enter it on the DOS command line if you wished to
  172.                 invoke the editor from the current drive/directory.
  173.  
  174.     F3 or E -   edit the current (drive:\directory\)filename(.extension)
  175.                 using the program named in Editor.
  176.  
  177.  
  178.  
  179.  
  180.                                       - 3 -
  181.     F4 or A -   invoke the A86 Assembler, with the current file.extension,
  182.                 and adding the current status of the 'O' and 'S' switches.
  183.                 A86 (and its supporting files) MUST be available from the
  184.                 current drive/directory or the current PATH/APPEND.
  185.  
  186.     F5 or R -   run the current filename. The extension is NOT added on,
  187.                 as it is assumed that the runtime version is either a
  188.                 '.COM' or '.EXE' file. You will be prompted to enter any
  189.                 command-line parameters or switches which are needed to
  190.                 run the program (e.q. a filename, or /a /3 - type switches).
  191.  
  192.     F6 or O -   this will toggle the 'O' switch for A86 assembly (goes 
  193.                 from on to off to on ... etc). The 'O' switch controls
  194.                 the creation of linkable .OBJ(ect) files. A86 usually
  195.                 creates directly executable .COM files (with no object
  196.                 file), but if you wish to create an object file, turn 
  197.                 this switch ON.
  198.  
  199.     F7 or S -   this toggles the 'S' switch for A86. Normally, A86 creates
  200.                 .SYM(bol) files ('S' = ON), but if you wish to NOT create
  201.                 a symbol file, toggle this switch to OFF.
  202.  
  203.     F8 or F -   this changes the file extension which will be appended to
  204.                 the filename when editing or assembling the file. It also
  205.                 controls the files selected when you ask for a DIRectory
  206.                 listing ('DIR *.ext') in the next option. If you wish for 
  207.                 a directory listing of ALL files in the current directory,
  208.                 then NULL (with a space) this field before asking for your
  209.                 listing.
  210.  
  211.     F9 or ? -   this produces a directory listing of the current directory.
  212.                 The command used will be 'DIR *.ext' where 'ext' is the above
  213.                 described file extension.
  214.  
  215.    F10 or D -   this will shell you out to DOS. You may enter any DOS command
  216.                 or commands you wish. Return to ASENV by typing 'EXIT' at
  217.                 the DOS command line prompt.
  218.  
  219.  
  220.                 ** NOTE ** - When you 'shell' out to DOS, you are actually
  221.                 running a second (or more) version of command.com, and the
  222.                 original program(s) from the prior level(s) of DOS are STILL
  223.                 IN MEMORY. This means that your available memory will be LESS
  224.                 than normal, and you may not be able to run certain programs.
  225.                 Also, be aware that you may change environment settings while
  226.                 in the shell, but any changes made will disappear when you
  227.                 'popup' to the prior DOS level. The DOS shell starts out with
  228.                 the same environment settings as the calling level, but these
  229.                 are just a COPY, not the original ones. The original settings
  230.                 are restored when you 'EXIT' the shell level.
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.                                       - 4 -
  241.     C       -   this allows you to change your current drive and/or
  242.                 directory. The filename and file extension are NOT affected,
  243.                 so if you are working on 'C:\ASM\TEST.SRC', for instance,
  244.                 and you change your directory to 'D:\BASIC', ASENV will
  245.                 still be looking for the TEST.SRC file for editing and
  246.                 assembling, and the TEST file for running, only now it is
  247.                 searching the 'D:\BASIC' directory for them.
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.     NOTES ON FIELD ENTRY:
  260.  
  261.     When entering into one of the text fields (Workfile, Pgm Editor, File
  262.     Extension, Current directory, or command-line switches), the following
  263.     considerations are in effect :
  264.  
  265.     1)  The available size of the text-entry field will be highlighted.
  266.  
  267.     2)  If there is presently data in the variable being entered, the
  268.         existing data will be displayed in the field.
  269.  
  270.     3)  A carriage-return (enter key) entered as the FIRST character
  271.         of a field already containing data will retain the displayed
  272.         data.
  273.  
  274.     4)  A SPACE entered as the FIRST and ONLY character of a field will
  275.         null that field (make the variable = "").
  276.  
  277.     5)  ONLY the characters entered (up to a return) will be retained
  278.         as data for that field, NOT the full displayed line. For example,
  279.         if a field already contains 'abcedfghi', and you enter 'wxyz' then
  280.         a return, the field will now contain 'wzyx', NOT 'wxyzfghi'.
  281.  
  282.     6)  You may backspace (with the backspace OR left-arrow keys) to 
  283.         correct an entry. As you backspace, previously overwritten characters
  284.         will 'reappear', but they are NOT part of the entry string (see #5),
  285.         UNLESS you backspace to the beginning of the entry, in which case
  286.         #3 above applies.
  287.  
  288.     7)  At ANY point in the text-entry field you may enter an <escape> key.
  289.         This has the effect of exiting the test-entry WITHOUT any changes
  290.         or entries being retained. (sort of 'I changed my mind' type).
  291.  
  292.     8)  More advanced editing functions (insert, delete, tabbing, etc.)
  293.         are NOT (yet!) supported. This is strictly a 'what you type is what
  294.         you get' data entry, NOT data editing!
  295.  
  296.     9)  If you attempt to enter any unacceptable keys, they will be rejected
  297.         and the system will 'beep' at you.
  298.  
  299.  
  300.                                       - 5 -
  301.  
  302.  
  303.     IN CLOSING:
  304.  
  305.     This is version 0.1 September, 1991. Please bear in mind that this is
  306.     only a hobby (at this point), and probably worth every penny you paid
  307.     for it!. Enjoy !
  308.  
  309.  
  310.     REVISION HISTORY:
  311.  
  312.  
  313.     ver 0.1 - Initial release - October, 1991
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.  
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334.  
  335.  
  336.  
  337.  
  338.  
  339.  
  340.  
  341.  
  342.  
  343.  
  344.  
  345.  
  346.  
  347.  
  348.  
  349.  
  350.  
  351.  
  352.  
  353.  
  354.  
  355.  
  356.  
  357.  
  358.  
  359.  
  360.  
  361.  
  362.  
  363.  
  364.                                       - 6 -
  365.  
  366.